home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XStoreBytes.z / XStoreBytes
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSttttoooorrrreeeeBBBByyyytttteeeessss((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))   XXXXSSSSttttoooorrrreeeeBBBByyyytttteeeessss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XStoreBytes, XStoreBuffer, XFetchBytes, XFetchBuffer,
  10.           XRotateBuffers - manipulate cut and paste buffers
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           XStoreBytes(_d_i_s_p_l_a_y, _b_y_t_e_s, _n_b_y_t_e_s)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 char *_b_y_t_e_s;
  16.                 int _n_b_y_t_e_s;
  17.  
  18.           XStoreBuffer(_d_i_s_p_l_a_y, _b_y_t_e_s, _n_b_y_t_e_s, _b_u_f_f_e_r)
  19.                 Display *_d_i_s_p_l_a_y;
  20.                 char *_b_y_t_e_s;
  21.                 int _n_b_y_t_e_s;
  22.                 int _b_u_f_f_e_r;
  23.  
  24.           char *XFetchBytes(_d_i_s_p_l_a_y, _n_b_y_t_e_s__r_e_t_u_r_n)
  25.                 Display *_d_i_s_p_l_a_y;
  26.                 int *_n_b_y_t_e_s__r_e_t_u_r_n;
  27.  
  28.           char *XFetchBuffer(_d_i_s_p_l_a_y, _n_b_y_t_e_s__r_e_t_u_r_n, _b_u_f_f_e_r)
  29.                 Display *_d_i_s_p_l_a_y;
  30.                 int *_n_b_y_t_e_s__r_e_t_u_r_n;
  31.                 int _b_u_f_f_e_r;
  32.  
  33.           XRotateBuffers(_d_i_s_p_l_a_y, _r_o_t_a_t_e)
  34.                 Display *_d_i_s_p_l_a_y;
  35.                 int _r_o_t_a_t_e;
  36.  
  37.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  38.           _b_u_f_f_e_r    Specifies the buffer in which you want to store
  39.                     the bytes or from which you want the stored data
  40.                     returned.
  41.  
  42.           _b_y_t_e_s     Specifies the bytes, which are not necessarily
  43.                     ASCII or null-terminated.
  44.  
  45.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  46.  
  47.           _n_b_y_t_e_s    Specifies the number of bytes to be stored.
  48.  
  49.           _n_b_y_t_e_s__r_e_t_u_r_n
  50.                     Returns the number of bytes in the buffer.
  51.  
  52.           _r_o_t_a_t_e    Specifies how much to rotate the cut buffers.
  53.  
  54.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  55.           The data can have embedded null characters and need not be
  56.           null-terminated.  The cut buffer's contents can be retrieved
  57.           later by any client calling _X_F_e_t_c_h_B_y_t_e_s.
  58.  
  59.           _X_S_t_o_r_e_B_y_t_e_s can generate a _B_a_d_A_l_l_o_c error.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSttttoooorrrreeeeBBBByyyytttteeeessss((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))   XXXXSSSSttttoooorrrreeeeBBBByyyytttteeeessss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           If an invalid buffer is specified, the call has no effect.
  75.           The data can have embedded null characters and need not be
  76.           null-terminated.
  77.  
  78.           _X_S_t_o_r_e_B_u_f_f_e_r can generate a _B_a_d_A_l_l_o_c error.
  79.  
  80.           The _X_F_e_t_c_h_B_y_t_e_s function returns the number of bytes in the
  81.           nbytes_return argument, if the buffer contains data.
  82.           Otherwise, the function returns NULL and sets nbytes to 0.
  83.           The appropriate amount of storage is allocated and the
  84.           pointer returned.  The client must free this storage when
  85.           finished with it by calling _X_F_r_e_e.
  86.  
  87.           The _X_F_e_t_c_h_B_u_f_f_e_r function returns zero to the nbytes_return
  88.           argument if there is no data in the buffer or if an invalid
  89.           buffer is specified.
  90.  
  91.           _X_F_e_t_c_h_B_u_f_f_e_r can generate a _B_a_d_V_a_l_u_e error.
  92.  
  93.           The _X_R_o_t_a_t_e_B_u_f_f_e_r_s function rotates the cut buffers, such
  94.           that buffer 0 becomes buffer n, buffer 1 becomes n + 1 mod
  95.           8, and so on.  This cut buffer numbering is global to the
  96.           display.  Note that _X_R_o_t_a_t_e_B_u_f_f_e_r_s generates _B_a_d_M_a_t_c_h errors
  97.           if any of the eight buffers have not been created.
  98.  
  99.           _X_R_o_t_a_t_e_B_u_f_f_e_r_s can generate a _B_a_d_M_a_t_c_h error.
  100.  
  101.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  102.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  103.                     resource or server memory.
  104.  
  105.           _B_a_d_A_t_o_m   A value for an Atom argument does not name a
  106.                     defined Atom.
  107.  
  108.           _B_a_d_M_a_t_c_h  Some argument or pair of arguments has the correct
  109.                     type and range but fails to match in some other
  110.                     way required by the request.
  111.  
  112.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  113.                     values accepted by the request.  Unless a specific
  114.                     range is specified for an argument, the full range
  115.                     defined by the argument's type is accepted.  Any
  116.                     argument defined as a set of alternatives can
  117.                     generate this error.
  118.  
  119.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  120.           XFree(3X11)
  121.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.